Carbon


GetMenuItemRefCon

Header: Menus.h Carbon status: Supported

Obtains application-specific information for a menu item.

OSErr GetMenuItemRefCon (
    MenuHandle inMenu, 
    SInt16 inItem, 
    UInt32 *outRefCon
);
inMenu

A handle to the menu that contains the menu item for which you wish to get information.

inItem

An integer representing the item number of the menu item.

outRefCon

A pointer to an unsigned 32-bit integer value. On return, the value is set to the reference constant associated with the menu item.

function result

A result code.

DISCUSSION

If you have assigned any data to a menu item using SetMenuItemRefCon function, you can read it using the GetMenuItemRefCon function.

See also the function SetMenuItemRefCon.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when CarbonLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by CarbonLib 1.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)